<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:14 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Container (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="Container (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Container.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/gephi/io/importer/api/AbstractDatabase.html" title="class in org.gephi.io.importer.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/gephi/io/importer/api/ContainerFactory.html" title="interface in org.gephi.io.importer.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/gephi/io/importer/api/Container.html" target="_top">Frames</a></li>
<li><a href="Container.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.io.importer.api</div>
<h2 title="Interface Container" class="title">Interface Container</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">Container</span></pre>
<div class="block">A container is created each time data are imported by <b>importers</b>. Its role is to host all data
 collected by importers during import process. After pushing data in the container, its content can be
 analysed to verify its validity and then be processed by <b>processors</b>. Thus containers are
 <b>loaded</b> by importers and <b>unloaded</b> by processors.
 <p>
 See <a href="../../../../../org/gephi/io/importer/api/ContainerLoader.html" title="interface in org.gephi.io.importer.api"><code>ContainerLoader</code></a> for how to push graph and attributes data in the container and see
 <a href="../../../../../org/gephi/io/importer/api/ContainerUnloader.html" title="interface in org.gephi.io.importer.api"><code>ContainerUnloader</code></a> for how to retrieve data in the container.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Mathieu Bastian</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/gephi/io/importer/spi/Importer.html" title="interface in org.gephi.io.importer.spi"><code>Importer</code></a>, 
<a href="../../../../../org/gephi/io/processor/spi/Processor.html" title="interface in org.gephi.io.processor.spi"><code>Processor</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#closeLoader()">closeLoader</a></strong>()</code>
<div class="block">Close the current loading and clean content before unloading.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/gephi/io/importer/api/ContainerLoader.html" title="interface in org.gephi.io.importer.api">ContainerLoader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#getLoader()">getLoader</a></strong>()</code>
<div class="block">Get containers loading interface.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/gephi/io/importer/api/Report.html" title="class in org.gephi.io.importer.api">Report</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#getReport()">getReport</a></strong>()</code>
<div class="block">Returns the report associated to this container, if exists.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#getSource()">getSource</a></strong>()</code>
<div class="block">If exists, returns the source of the data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/gephi/io/importer/api/ContainerUnloader.html" title="interface in org.gephi.io.importer.api">ContainerUnloader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#getUnloader()">getUnloader</a></strong>()</code>
<div class="block">Get containers unloading interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#isAutoScale()">isAutoScale</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#isDynamicGraph()">isDynamicGraph</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#isHierarchicalGraph()">isHierarchicalGraph</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#setAllowAutoNode(boolean)">setAllowAutoNode</a></strong>(boolean&nbsp;value)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#setAllowParallelEdge(boolean)">setAllowParallelEdge</a></strong>(boolean&nbsp;value)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#setAllowSelfLoop(boolean)">setAllowSelfLoop</a></strong>(boolean&nbsp;value)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#setAutoScale(boolean)">setAutoScale</a></strong>(boolean&nbsp;autoscale)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#setReport(org.gephi.io.importer.api.Report)">setReport</a></strong>(<a href="../../../../../org/gephi/io/importer/api/Report.html" title="class in org.gephi.io.importer.api">Report</a>&nbsp;report)</code>
<div class="block">Set a report this container can use to report issues detected when loading the container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#setSource(java.lang.String)">setSource</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;source)</code>
<div class="block">Set the source of the data put in the container.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#setUndirectedSumDirectedEdgesWeight(boolean)">setUndirectedSumDirectedEdgesWeight</a></strong>(boolean&nbsp;value)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/io/importer/api/Container.html#verify()">verify</a></strong>()</code>
<div class="block">This method must be called after the loading is complete and before unloading.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="setSource(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSource</h4>
<pre>void&nbsp;setSource(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;source)</pre>
<div class="block">Set the source of the data put in the container. Could be a file name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - the original source of data.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>source</code> is <code>null</code></dd></dl>
</li>
</ul>
<a name="getSource()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSource</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getSource()</pre>
<div class="block">If exists, returns the source of the data.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the source of the data, or <code>null</code> if source is not defined.</dd></dl>
</li>
</ul>
<a name="getLoader()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLoader</h4>
<pre><a href="../../../../../org/gephi/io/importer/api/ContainerLoader.html" title="interface in org.gephi.io.importer.api">ContainerLoader</a>&nbsp;getLoader()</pre>
<div class="block">Get containers loading interface. The <b>loader</b> is used by modules which put data in the
 container, whereas the <b>unloader</b> interface is used by modules which read containers content.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the containers loading interface</dd></dl>
</li>
</ul>
<a name="getUnloader()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnloader</h4>
<pre><a href="../../../../../org/gephi/io/importer/api/ContainerUnloader.html" title="interface in org.gephi.io.importer.api">ContainerUnloader</a>&nbsp;getUnloader()</pre>
<div class="block">Get containers unloading interface. The <b>unloader</b> interface is used by modules which read
 containers content, whereas the <b>loader</b> is used for pushing data in the container.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the container unloading interface</dd></dl>
</li>
</ul>
<a name="setAutoScale(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutoScale</h4>
<pre>void&nbsp;setAutoScale(boolean&nbsp;autoscale)</pre>
</li>
</ul>
<a name="isAutoScale()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAutoScale</h4>
<pre>boolean&nbsp;isAutoScale()</pre>
</li>
</ul>
<a name="setAllowSelfLoop(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowSelfLoop</h4>
<pre>void&nbsp;setAllowSelfLoop(boolean&nbsp;value)</pre>
</li>
</ul>
<a name="setAllowAutoNode(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowAutoNode</h4>
<pre>void&nbsp;setAllowAutoNode(boolean&nbsp;value)</pre>
</li>
</ul>
<a name="setAllowParallelEdge(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowParallelEdge</h4>
<pre>void&nbsp;setAllowParallelEdge(boolean&nbsp;value)</pre>
</li>
</ul>
<a name="setUndirectedSumDirectedEdgesWeight(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUndirectedSumDirectedEdgesWeight</h4>
<pre>void&nbsp;setUndirectedSumDirectedEdgesWeight(boolean&nbsp;value)</pre>
</li>
</ul>
<a name="setReport(org.gephi.io.importer.api.Report)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReport</h4>
<pre>void&nbsp;setReport(<a href="../../../../../org/gephi/io/importer/api/Report.html" title="class in org.gephi.io.importer.api">Report</a>&nbsp;report)</pre>
<div class="block">Set a report this container can use to report issues detected when loading the container. Report
 are used to log info and issues during import process. Only one report can be associated to a
 container.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>report</code> - set <code>report</code> as the default report for this container</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>report</code> is <code>null</code></dd></dl>
</li>
</ul>
<a name="getReport()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReport</h4>
<pre><a href="../../../../../org/gephi/io/importer/api/Report.html" title="class in org.gephi.io.importer.api">Report</a>&nbsp;getReport()</pre>
<div class="block">Returns the report associated to this container, if exists.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the report set for this container or <code>null</code> if no report is defined</dd></dl>
</li>
</ul>
<a name="verify()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verify</h4>
<pre>boolean&nbsp;verify()</pre>
<div class="block">This method must be called after the loading is complete and before unloading. Its aim is to verify data consistency as a whole.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if container data is consistent, <code>false</code> otherwise</dd></dl>
</li>
</ul>
<a name="closeLoader()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeLoader</h4>
<pre>void&nbsp;closeLoader()</pre>
<div class="block">Close the current loading and clean content before unloading.</div>
</li>
</ul>
<a name="isDynamicGraph()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDynamicGraph</h4>
<pre>boolean&nbsp;isDynamicGraph()</pre>
</li>
</ul>
<a name="isHierarchicalGraph()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isHierarchicalGraph</h4>
<pre>boolean&nbsp;isHierarchicalGraph()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Container.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/gephi/io/importer/api/AbstractDatabase.html" title="class in org.gephi.io.importer.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/gephi/io/importer/api/ContainerFactory.html" title="interface in org.gephi.io.importer.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/gephi/io/importer/api/Container.html" target="_top">Frames</a></li>
<li><a href="Container.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
